Crate alloy_primitives

source ·
Expand description

§alloy-primitives

Primitive types shared by alloy, foundry, revm, and reth.

§Types

  • Unsigned integers re-exported from ruint
  • Signed integers, as a wrapper around ruint integers
  • Fixed-size byte arrays via FixedBytes
    • wrap_fixed_bytes!: macro for constructing named fixed bytes types
    • Address, which is a fixed-size byte array of 20 bytes, with EIP-55 and EIP-1191 checksum support
    • fixed_bytes!, address! and other macros to construct the types at compile time

§Examples

This library has straightforward, basic, types. Usage is correspondingly simple. Please consult the documentation for more information.

use alloy_primitives::{address, fixed_bytes, Address, FixedBytes, I256, U256};

// FixedBytes
let n: FixedBytes<6> = fixed_bytes!("1234567890ab");
assert_eq!(n, "0x1234567890ab".parse::<FixedBytes<6>>().unwrap());
assert_eq!(n.to_string(), "0x1234567890ab");

// Uint
let mut n: U256 = "42".parse().unwrap();
n += U256::from(10);
assert_eq!(n.to_string(), "52");

// Signed
let mut n: I256 = "-42".parse().unwrap();
n = -n;
assert_eq!(n.to_string(), "42");

// Address
let addr_str = "0x66f9664f97F2b50F62D13eA064982f936dE76657";
let addr: Address = Address::parse_checksummed(addr_str, None).unwrap();
assert_eq!(addr, address!("66f9664f97F2b50F62D13eA064982f936dE76657"));
assert_eq!(addr.to_checksum(None), addr_str);

// Address checksummed with a custom chain id
let addr_str = "0x66F9664f97f2B50F62d13EA064982F936de76657";
let addr: Address = Address::parse_checksummed(addr_str, Some(30)).unwrap();
assert_eq!(addr, address!("66F9664f97f2B50F62d13EA064982F936de76657"));
assert_eq!(addr.to_checksum(Some(30)), addr_str);

Re-exports§

Modules§

Macros§

  • address
    Converts a sequence of string literals containing hex-encoded data into a new Address at compile time.
  • b64
    Converts a sequence of string literals containing hex-encoded data into a new B64 at compile time.
  • b128
    Converts a sequence of string literals containing hex-encoded data into a new B128 at compile time.
  • b256
    Converts a sequence of string literals containing hex-encoded data into a new B256 at compile time.
  • b512
    Converts a sequence of string literals containing hex-encoded data into a new B512 at compile time.
  • bloom
    Converts a sequence of string literals containing hex-encoded data into a new Bloom at compile time.
  • bytes
    Converts a sequence of string literals containing hex-encoded data into a new Bytes at compile time.
  • fixed_bytes
    Converts a sequence of string literals containing hex-encoded data into a new FixedBytes at compile time.
  • try_vec
    Tries to create a Vec of n elements, each initialized to elem.
  • wrap_fixed_bytes
    Wrap a fixed-size byte array in a newtype, delegating all methods to the underlying crate::FixedBytes.

Structs§

  • Address
    An Ethereum address, 20 bytes in length.
  • AddressChecksumBuffer
    Stack-allocated buffer for efficiently computing address checksums.
  • BigIntConversionError
    The error type that is returned when conversion to or from a integer fails.
  • Bloom
    Ethereum 256 byte bloom filter.
  • Bytes
    Wrapper type around bytes::Bytes to support “0x” prefixed hex strings.
  • FixedBytes
    A byte array of fixed length ([u8; N]).
  • Function
    An Ethereum ABI function pointer, 24 bytes in length.
  • Log
    A log consists of an address, and some log data.
  • LogData
    An Ethereum event log object.
  • PrivateSignatureunstable-doc
    Only available for documentation purposes. An Ethereum ECDSA signature.
  • Sealed
    A consensus hashable item, with its memoized hash.
  • Signed
    Signed integer wrapping a ruint::Uint.

Enums§

  • AddressError
    Error type for address checksum validation.
  • BloomInput
    Input to the Bloom::accrue method.
  • Parity
    The parity of the signature, stored as either a V value (which may include a chain id), or the y-parity.
  • ParseSignedError
    The error type that is returned when parsing a signed integer.
  • Sign
    Enum to represent the sign of a 256-bit signed integer.
  • SignatureError
    Errors in signature parsing or verification.
  • TxKind
    The to field of a transaction. Either a target address, or empty for a contract creation.

Constants§

Traits§

  • IntoLogData
    Trait for an object that can be converted into a log data object.
  • Sealable
    Sealeable objects.

Functions§

Type Aliases§